wfm-ux
TMF666-GET-Retrieve BillingAccount Details by AccountNo
This operation allows to retrieve billing account details and additional contact information based on provided inputs such as accountNumber for JM.
Key Considerations for Liberate FTTH Implementation
- id-uriparam (i.e. AccountNumber) is mandatory to retrieve the billing account details from Liberate.
- This is implemented for JM market.
- Additional parameter called sourceBSS will be provided in the response to know the request is for Liberate/Cerillion.
- Contact information will be provided under payalod.contact array.
- payload.contact[].contactMedium where contactMedium.mediumType == "BillingAddress" is providing the billing address information for the provided account from Liberate.
All other objects apart from BillingAddress object under payalod.contact array will provide the contact information from Liberate. The object consists of below fields
- contactName,
- partyRoleType(Ex. OWNER, RELAT, etc.,),
- contactMedium[] - Provides all the available contact methods for JM.
Below are all possible contactMethods in Liberate for JM.
| S.No | Liberate ContactMethod | Description | MediumType(ESB) | ContactType(ESB) |
|---|---|---|---|---|
| 1 | BILLEM | E-mail ID to recieve Bill | billEmail | |
| 2 | E-mail Address | |||
| 3 | FAX | FAX number | Fax | fax |
| 4 | HOME | Home Number | Telephone | home |
| 5 | IVR | IVR Primary Contact Number | IVR | ivr |
| 6 | IVR1 | IVR Alternate Contact Number 1 | IVR | ivr1 |
| 7 | IVR2 | IVR Alternate Contact Number 2 | IVR | ivr2 |
| 8 | IVR3 | IVR Alternate Contact Number 3 | IVR | ivr3 |
| 9 | MOB1 | Mobile Number 1 | Mobile | mobile1 |
| 10 | MOB2 | Mobile Number 2 | Mobile | mobile2 |
| 11 | PHONE | Telephone and ext. no. | Telephone | phone |
| 12 | WORK | Work Number | Telephone | work |
URL
https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/{businessId}/billingAccount/{id}URI Params
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | Unique identifier of the Billing Account | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
cURL request for FTTH-Liberate
curl --location 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/billingAccount/301202420000' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b'Response for FTTH-Liberate
{
"id": "301202420000",
"billable": true,
"accountType": "R",
"description": "Residence",
"name": "MR Wayne Thompson",
"paymentStatus": "In Arrears",
"state": "W-Working",
"accountBalance": [
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "NetPayable"
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2025-07-29T00:00:00.000Z"
}
},
{
"amount": {
"value": 6786.25,
"unit": "JMD"
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2025-06-28T00:00:00.000Z"
}
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositRequired"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalQuery"
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositHeld"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "Total Query Tax"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalAdjustmentCredit"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalDepositPaid"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalServiceChargeCredit"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalRewards"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalAvailablePointsAmount"
}
],
"billStructure": {
"cycleSpecification": {
"id": "H",
"paymentDueDate": "2025-07-29T00:00:00.000Z",
"billingDay": 9
},
"presentationMedia": [
{
"id": "E",
"name": "Electronic Bills"
},
{
"id": "E",
"name": "BillLanguage"
}
]
},
"paymentPlan": [
{
"priority": 0,
"planType": "W",
"status": "true",
"@type": "SupportsRecurringPayments"
}
],
"relatedParty": [
{
"id": "106847724",
"name": "MR Wayne Thompson",
"role": "customer",
"@type": "Customer",
"@referredType": "Customer",
"@baseType": "RelatedParty",
"characteristic": [
{
"name": "DocumentType",
"value": "TR"
},
{
"name": "DocumentNumber",
"value": "106847724"
},
{
"name": "Email",
"value": "jahson80@gmail.com"
},
{
"name": "Gender",
"value": "M"
},
{
"name": "Title",
"value": "MR",
"valueType": "string"
},
{
"name": "FirstName",
"value": "Wayne",
"valueType": "string"
},
{
"name": "LastName",
"value": "Thompson",
"valueType": "string"
},
{
"name": "OtherName",
"value": "UMAR",
"valueType": "string"
},
{
"name": "CompanyName",
"value": "Latoya Green",
"valueType": "string"
},
{
"name": "Date-Of-Birth",
"value": "12-May-1969 00:00:00",
"valueType": "string"
},
{
"name": "Customer Identity",
"valueType": "array",
"value": [
{
"DocumentType": "SS",
"DocumentNumber": "106847724",
"DocumentDescription": "Driving L No."
},
{
"DocumentType": "TR",
"DocumentNumber": "106847724",
"DocumentDescription": "TRN Number"
}
]
}
]
},
{
"id": "0",
"role": "MigratedAccount"
},
{
"id": "LIME",
"role": "legalEntity"
},
{
"@type": "Account",
"characteristic": [
{
"name": "BaseAccountType",
"value": "RES"
}
]
},
{
"id": "990000",
"name": "Residential",
"role": "marketingCategory"
}
],
"contact": [
{
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "Lot 174c South Haven",
"street2": " South Haven",
"city": "Yallahs",
"stateOrProvince": "St Thomas",
"country": "Jamaica",
"postCode": "00000"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "1234567"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com"
}
}
]
},
{
"contactName": "WAYNE THOMPSON",
"partyRoleType": "OWNER",
"contactMedium": [
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com",
"contactType": "billEmail"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com",
"contactType": "email"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8763306113",
"contactType": "mobile1"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "mobile2"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "home"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "phone"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "work"
}
},
{
"mediumType": "Fax",
"characteristic": {
"faxNumber": "84786620",
"contactType": "fax"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr1"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr2"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr3"
}
}
]
},
{
"contactName": "Fay Thompson",
"partyRoleType": "RELAT",
"contactMedium": [
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "mobile1"
}
}
]
}
],
"creditLimit": {
"unit": "JMD",
"value": 0
},
"defaultPaymentMethod": {
"id": "E",
"name": "Electronic"
},
"financialAccount": {
"id": "301202420000",
"@referredType": "FinancialAccount"
},
"accountRelationship": [
{
"account": {
"name": ""
},
"relationshipType": "MigratedBillingSystem"
}
],
"sourceBSS": "LIBERATE"
}